fragment/androidx.fragment.app/[main]FragmentTransaction

FragmentTransaction

abstract class FragmentTransaction(source)

Static library support version of the framework's android.app.FragmentTransaction. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

Constructors

FragmentTransaction

constructor()

Properties

TRANSIT_ENTER_MASK

val TRANSIT_ENTER_MASK: Int = 4096

Bit mask that is set for all enter transitions.

TRANSIT_EXIT_MASK

val TRANSIT_EXIT_MASK: Int = 8192

Bit mask that is set for all exit transitions.

TRANSIT_FRAGMENT_CLOSE

val TRANSIT_FRAGMENT_CLOSE: Int = 8194

Fragment is being removed from the stack

TRANSIT_FRAGMENT_FADE

val TRANSIT_FRAGMENT_FADE: Int = 4099

Fragment should simply fade in or out; that is, no strong navigation associated with it except that it is appearing or disappearing for some reason.

TRANSIT_FRAGMENT_MATCH_ACTIVITY_CLOSE

val TRANSIT_FRAGMENT_MATCH_ACTIVITY_CLOSE: Int = 8197

Fragment is being removed from the stack with Activity close transition.

TRANSIT_FRAGMENT_MATCH_ACTIVITY_OPEN

val TRANSIT_FRAGMENT_MATCH_ACTIVITY_OPEN: Int = 4100

Fragment is being added onto the stack with Activity open transition.

TRANSIT_FRAGMENT_OPEN

val TRANSIT_FRAGMENT_OPEN: Int = 4097

Fragment is being added onto the stack

val TRANSIT_NONE: Int = 0

No animation for transition.

val TRANSIT_UNSET: Int = -1

Not set up for a transition.

Functions

open fun add(@NonNull fragment: Fragment, @Nullable tag: String): FragmentTransaction

fun add(@NonNull fragmentClass: Class<out Fragment>, @Nullable args: Bundle, @Nullable tag: String): FragmentTransaction

Calls add with a 0 containerViewId.

open fun add(@IdRes containerViewId: Int, @NonNull fragment: Fragment): FragmentTransaction

fun add(@IdRes containerViewId: Int, @NonNull fragmentClass: Class<out Fragment>, @Nullable args: Bundle): FragmentTransaction

Calls add with a null tag.

fun add(@NonNull container: ViewGroup, @NonNull fragment: Fragment, @Nullable tag: String): FragmentTransaction

open fun add(@IdRes containerViewId: Int, @NonNull fragment: Fragment, @Nullable tag: String): FragmentTransaction

fun add(@IdRes containerViewId: Int, @NonNull fragmentClass: Class<out Fragment>, @Nullable args: Bundle, @Nullable tag: String): FragmentTransaction

Add a fragment to the activity state.

addSharedElement

open fun addSharedElement(@NonNull sharedElement: View, @NonNull name: String): FragmentTransaction

Used with custom Transitions to map a View from a removed or hidden Fragment to a View from a shown or added Fragment.

open fun addToBackStack(@Nullable name: String): FragmentTransaction

Add this transaction to the back stack.

open fun attach(@NonNull fragment: Fragment): FragmentTransaction

Re-attach a fragment after it had previously been detached from the UI with detach.

abstract fun commit(): Int

Schedules a commit of this transaction.

commitAllowingStateLoss

abstract fun commitAllowingStateLoss(): Int

Like commit but allows the commit to be executed after an activity's state is saved.

abstract fun commitNow()

Commits this transaction synchronously.

commitNowAllowingStateLoss

abstract fun commitNowAllowingStateLoss()

Like commitNow but allows the commit to be executed after an activity's state is saved.

open fun detach(@NonNull fragment: Fragment): FragmentTransaction

Detach the given fragment from the UI.

disallowAddToBackStack

open fun disallowAddToBackStack(): FragmentTransaction

Disallow calls to addToBackStack.

open fun hide(@NonNull fragment: Fragment): FragmentTransaction

Hides an existing fragment.

isAddToBackStackAllowed

open fun isAddToBackStackAllowed(): Boolean

Returns true if this FragmentTransaction is allowed to be added to the back stack.

open fun isEmpty(): Boolean

open fun remove(@NonNull fragment: Fragment): FragmentTransaction

Remove an existing fragment.

open fun replace(@IdRes containerViewId: Int, @NonNull fragment: Fragment): FragmentTransaction

fun replace(@IdRes containerViewId: Int, @NonNull fragmentClass: Class<out Fragment>, @Nullable args: Bundle): FragmentTransaction

Calls replace with a null tag.

open fun replace(@IdRes containerViewId: Int, @NonNull fragment: Fragment, @Nullable tag: String): FragmentTransaction

fun replace(@IdRes containerViewId: Int, @NonNull fragmentClass: Class<out Fragment>, @Nullable args: Bundle, @Nullable tag: String): FragmentTransaction

Replace an existing fragment that was added to a container.

open fun runOnCommit(@NonNull runnable: Runnable): FragmentTransaction

Add a Runnable to this transaction that will be run after this transaction has been committed.

seslSetAnimations

@RequiresApi(value = 23)

fun FragmentTransaction.~~seslSetAnimations~~(): FragmentTransaction

@RequiresApi(value = 23)

fun FragmentTransaction.seslSetAnimations(context: Context): FragmentTransaction

setAllowOptimization

open fun ~~setAllowOptimization~~(allowOptimization: Boolean): FragmentTransaction

open fun setAnimations(): FragmentTransaction

setBreadCrumbShortTitle

open fun ~~setBreadCrumbShortTitle~~(@StringRes res: Int): FragmentTransaction

Set the short title to show as a bread crumb when this transaction is on the back stack.

open fun ~~setBreadCrumbShortTitle~~(@Nullable text: CharSequence): FragmentTransaction

Like setBreadCrumbShortTitle but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.

setBreadCrumbTitle

open fun ~~setBreadCrumbTitle~~(@StringRes res: Int): FragmentTransaction

Set the full title to show as a bread crumb when this transaction is on the back stack.

open fun ~~setBreadCrumbTitle~~(@Nullable text: CharSequence): FragmentTransaction

Like setBreadCrumbTitle but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.

setCustomAnimations

open fun setCustomAnimations(@AnimatorRes @AnimRes enter: Int, @AnimatorRes @AnimRes exit: Int): FragmentTransaction

open fun setCustomAnimations(@AnimatorRes @AnimRes enter: Int, @AnimatorRes @AnimRes exit: Int, @AnimatorRes @AnimRes popEnter: Int, @AnimatorRes @AnimRes popExit: Int): FragmentTransaction

Set specific animation resources to run for the fragments that are entering and exiting in this transaction.

setMaxLifecycle

open fun setMaxLifecycle(@NonNull fragment: Fragment, @NonNull state: Lifecycle.State): FragmentTransaction

Set a ceiling for the state of an active fragment in this FragmentManager.

setPrimaryNavigationFragment

open fun setPrimaryNavigationFragment(@Nullable fragment: Fragment): FragmentTransaction

Set a currently active fragment in this FragmentManager as the primary navigation fragment.

setReorderingAllowed

open fun setReorderingAllowed(reorderingAllowed: Boolean): FragmentTransaction

Sets whether or not to allow optimizing operations within and across transactions.

open fun setTransition(transition: Int): FragmentTransaction

Select a standard transition animation for this transaction.

setTransitionStyle

open fun ~~setTransitionStyle~~(@StyleRes styleRes: Int): FragmentTransaction

Set a custom style resource that will be used for resolving transit animations.

open fun show(@NonNull fragment: Fragment): FragmentTransaction

Shows a previously hidden fragment.